Skip to content

Document relative link resolution in MDX files#5384

Merged
ethanpalm merged 5 commits intomainfrom
mintlify/relative-links-fix-1776270322
Apr 24, 2026
Merged

Document relative link resolution in MDX files#5384
ethanpalm merged 5 commits intomainfrom
mintlify/relative-links-fix-1776270322

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 15, 2026

Summary

  • Updated the linking guide to document relative path support (./ and ../) including how they resolve in index.mdx files
  • Added a changelog entry for the bug fix that corrected relative link resolution in index pages

Relative links in MDX files now resolve correctly based on the source file's location. Previously, relative paths like ./foo in index.mdx files resolved against the wrong directory, causing broken links.


Note

Low Risk
Documentation-only updates describing relative path (.//../) behavior (including index.mdx resolution) with no runtime or API changes, so risk is minimal.

Overview
Clarifies internal linking guidance by documenting support for relative paths (./, ../), including how they resolve from index.mdx directories and that fragments/query strings are preserved.

Updates the FAQ to position root-relative links as the default recommendation while noting relative links can break more easily when files move.

Reviewed by Cursor Bugbot for commit 8b5e11c. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Apr 15, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 15, 2026, 4:31 PM

Comment thread changelog.mdx Outdated
Comment thread guides/linking.mdx Outdated
Comment thread guides/linking.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Comment thread guides/linking.mdx Outdated
Comment thread guides/linking.mdx Outdated
@ethanpalm ethanpalm merged commit 07dc704 into main Apr 24, 2026
5 checks passed
@ethanpalm ethanpalm deleted the mintlify/relative-links-fix-1776270322 branch April 24, 2026 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant